[<<Previous Entry] [^^Up^^] [Next Entry>>] [Menu] [About The Guide]
  Function            litebar_get - get user's choice from a litebar
                                      menu

  Syntax              int litebar_get(struct litebar_header *lh);

  Prototype in        menuhk.h

  Remarks             litebar_get does the actual prompting the user for
                      input. The following keys can be used to navigate
                      in the menu:

                           Up, Down,      Move select bar to another
                           Left, Right    command, as per parms to
                                          litebar_alloc(). See
                                          litebar_alloc() for more
                                          details.
                           ENTER          Select the hilited option
                           ESC            Abort

                      in addition to any cmdkeys and quitkeys.

                      Other actions may be taken before returning from
                      this function, according to the flags for the menu.
                      See litebar_alloc() for more details.

  Return value        returns zero if ESC was hit. If an command was
                      chosen, litebar_get() returns the number of the
                      command selected. This is not the array index of
                      the command. If command[] has 3 static text items
                      and a command, and the command is selected, a 1
                      will be returned, even though the command is the
                      fourth command with a command index of three
                      (command[3]). If a quitkey was hit, the return
                      value will be the key code for the quitkey, plus
                      1000 (i.e. Ctrl-Z, key code 26, as a quitkey will
                      return 1026 when it is hit.)

  See also            menuhk.h
                      changelitebar(), isHiliteable(), litebar_alloc(),
                      litebar_free(), litehilite(), litemessage(),
                      liteunlite(), menu_litebar()
                      litebarerrno

  Example             see demolite.c


See Also: litebar_alloc() litebar_free() menu_litebar()
This page created by ng2html v1.05, the Norton guide to HTML conversion utility. Written by Dave Pearson